Docs templates

您所在的位置:网站首页 quickstart for github pages Docs templates

Docs templates

2023-03-03 17:42| 来源: 网络整理| 查看: 265

Quickstart guide templateContributing a new quickstart guideNoteTemplateQuickstart guide template

Suggested template and guidance for creating a quickstart guide

Contributing a new quickstart guide

Dapr quickstart guides consist of quick instructions that walk readers through a prepared quickstart, saved to the dapr/quickstarts repo. These quickstarts package an entire feature or building block in one place, making it easy for the reader to experience how it works without compromising their own project.

The quickstart instructions should be succinct, direct, and clear. The sole purpose of a quickstart guide is to simply instruct a reader through the prepared quickstart. If you’d like to explain the concepts behind the quickstart, direct the reader to a concept article for more context.

Note

This template is only a suggestion. Feel free to change based on your document’s purpose.

Learn more about contributing to the Dapr docs, like front-matter and shortcodes.

Template---type: #Required; docstitle: #Required; "Quickstart: Brief, clear title"linkTitle: #Required; This will display in the docs table of contentsweight: #Required; Use the correct weight based on hierarchydescription: #Required; One-sentence description of what to expect in the article---## Pre-requisites## Step 1: Set up the environment## Step 2: ## Tell us what you think!We're continuously working to improve our Quickstart examples and value your feedback. Did you find this quickstart helpful? Do you have suggestions for improvement?Join the discussion in our [discord channel](https://discord.gg/22ZtJrNe).## Next steps

Last modified September 28, 2022: Upmerge v1.8 —> v1.9 - 9/28 (#2839) (9286e093)



【本文地址】


今日新闻


推荐新闻


CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3